/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.iotdb.metrics.type;

import java.util.Map;

public interface Rate extends IMetric {

    /**
     * Get the value of rate
     */
    long getCount();

    /**
     * Get one minute rate
     */
    double getOneMinuteRate();

    /**
     * Get mean rate
     */
    double getMeanRate();

    /**
     * Get five minute rate
     */
    double getFiveMinuteRate();

    /**
     * Get fifteen minute rate
     */
    double getFifteenMinuteRate();

    /**
     * Mark in rate
     */
    void mark();

    /**
     * Mark n in rate
     */
    void mark(long n);

    @Override
    default void constructValueMap(Map<String, Object> result) {
        result.put("count", getCount());
        result.put("mean", getMeanRate());
        result.put("m1", getOneMinuteRate());
        result.put("m5", getFiveMinuteRate());
        result.put("m15", getFifteenMinuteRate());
    }
}
